package risoe.syslab.fhnew.controller;

/*
 * Copyright (c) 2012-2014, Technical University of Denmark (DTU)
 * All rights reserved.
 * 
 * The Flexhouse 2.0 platform ("this software") is licensed under the
 * BSD 3-clause license.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of DTU nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE TECHNICAL UNIVERSITY OF DENMARK BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import java.rmi.Remote;
import java.rmi.RemoteException;

import risoe.syslab.fhnew.gui.VisualizationEvent;
import risoe.syslab.fhnew.hw.Actuator;
import risoe.syslab.fhnew.hw.Sensor;
import risoe.syslab.model.CompositeString;
import risoe.syslab.model.flexhouse.ControllerParameter;

/**
 * The remote interface representing a controller. Used for issuing sensor events to plugincontrollers.
 * @author M. Svendsen
 */
public interface PluginControllerInterface extends Remote {

	/**
	 * Called when a subscribed sensor is updated
	 * @param the sensor that caused this event
	 * @throws RemoteException
	 */
	public void sensorUpdated(Sensor sensor) throws RemoteException;
	
	/**
	 * Called when a subscribed actuator is updated
	 * @param the actuator that caused this event
	 * @throws RemoteException
	 */
	public void actuatorUpdated(Actuator actuator) throws RemoteException;
	
	/**
	 * Called when the controllermanager registers this controller. The plugincontroller must supply a controllerconfig
	 * object here.
	 * @return a controllerconfig specified by the plugincontroller
	 * @throws RemoteException
	 */
	public ControllerConfig getControllerConfig() throws RemoteException;
	
	/**
	 * Issues a heartbeat to this plugincontroller
	 * @return a boolean indicating a successful connection
	 * @throws RemoteException
	 */
	public boolean issueHeartBeat() throws RemoteException;
	
	/**
	 * Called by the Controller Manager when the visualization linked to this plugincontroller
	 * has issued an event.
	 * @param event the event that triggered this call
	 * @throws RemoteException
	 */
	public void onVisualizationEvent(VisualizationEvent event) throws RemoteException;

	/**
	 * Called from the controllerconfig associated with this plugincontroller. 
	 * This is used to reconstruct the SVG Document used in the visualization linked with this
	 * plugincontroller.
	 * @param serializedData a string representing the SVG Document
	 * @throws RemoteException
	 */
	public void onDocumentReady(String serializedData) throws RemoteException;

	public void controllerParameterUpdated(ControllerParameter parameter, CompositeString value) throws RemoteException;
}
